/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.replay;

import cgl.narada.matching.Profile;
import cgl.narada.service.ServiceException;

/*
 The Entity Replay Actuator which initiates replays and assorted 
 functionalities associated with replay services. 
 
 @author Shrideep Pallickara and Hasan Bulut
 $Date$
 $Revision$
 */

public abstract class EntityReplayActuator {

  private static EntityReplayActuator instance = cgl.narada.service.replay.impl.EntityReplayActuatorImpl
                                                   .getInstance();

  public static EntityReplayActuator getInstance() {
    System.out.println("\n\n\n\nInstance VALUE = " + instance + "\n\n\n");
    return instance;
  }
  
 
  /** Create a replay request based on the specified constraints */
  public abstract ReplayRequest createReplayRequest(int templateId,
      int entityId, long[] sequencesToReplay) throws ServiceException;

  /** Create a replay request based on the specified constraints */
  public abstract ReplayRequest createReplayRequest(int templateId,
      int entityId, long sequenceStart, long sequenceEnd)
      throws ServiceException;

  /** Create a replay request based on the specified constraints */
  public abstract ReplayRequest createReplayRequest(int templateId,
      int entityId, long sequenceStart, long sequenceEnd,
      Profile[] specifiedConstraints) throws ServiceException;

  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      boolean requestForTimestamp, long sequenceNumber) throws ServiceException;
			
  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      String replayRequestIdentifier, String replayTopic,
      boolean hasStartingSequenceAndEndingTimestamp, long startingSequence,
      long endingTimestamp) throws ServiceException;
  
  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      String replayTopic, long startTimestamp, long endTimestamp,
      boolean replayWithTimestampRange) throws ServiceException;

  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      long startTimestamp, long endTimestamp, boolean hasTimestampRange)
      throws ServiceException;
  
  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      boolean requestSequencesAndTimestamps) throws ServiceException;
      
  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      String replayTopic, long[] sequencesToReplay) throws ServiceException;

  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      String replayTopic, long sequenceStart, long sequenceEnd)
      throws ServiceException;
  
  public abstract ReplayRequest createReplayRequest(int templateId, int entityId,
      String replayTopic, long sequenceStart, long sequenceEnd,
      Profile[] specifiedConstraints) throws ServiceException;

  /** Check to see if replay is possible for a given templateId and entityId*/
  public abstract void checkIfReplayPossible(int templateId, int entityId)
      throws ServiceException;

  /** Retrieve a previously created replay request */
  public abstract ReplayRequest getReplayRequest(String replayIdentifier)
      throws ServiceException;

  /** Initiate replay based on the create replay request */
  public abstract void initiateReplay(ReplayRequest replayRequest,
      ReplayServiceListener replayListener) throws ServiceException;

  public abstract void replayToTopic(ReplayRequest replayRequest,
      ReplayServiceListener replayListener) throws ServiceException;

  public abstract void setQosService(
      cgl.narada.service.qos.impl.QosServiceImpl qosServiceImpl);
}